.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH Ptyxis 1 "09 July 2024"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
ptyxis \- a container-oriented terminal

.SH SYNOPSIS
.B ptyxis
.RI [OPTION]...
[\-\- PROGRAM ARGUMENTS]
.br

.SH DESCRIPTION
.B ptyxis
is a container-oriented, designed for the GNOME desktop.
It provides tight integration with podman, toolbox, distrobox,
and jhbuild to simplfy container-based development and system
management.
.br

.TP
.B \-\-version
Show the version of the program.

.TP
.B \-\-preferences
Show the preferences window.

.TP
.BR \-\-new\-window
Open a new window in an existing instance of Ptyxis. If Ptyxis
is not running, a new instance is started.

May be combined with
.B \-\-working\-directory
and
.B \-\-execute
and
.B \-\-title
options.

.TP
.BR \-\-tab
Open a new tab in the most-recently-used window of an existing
Ptyxis instance. If Ptyxis is not running, a new instance is
started.

May be combined with
.B \-\-working\-directory
and
.B \-\-execute
and
.B \-\-title
options.

.TP
.BR \-x ", " \-\-execute
Execute a custom command.

This is similar to using
.BR \-\-
to provide the custom command except that the entire command
line should be provided as a single argument.

In general, you should use
.BR \-\-
instead of this option. This is primarily available to be
similar to
.BR "bash -c 'command'"

May be combined with
.B \-\-working\-directory
and
.B \-\-title
options.

.TP
.BR \-d ", " \-\-working\-directory
Set the current working directory for a new tab, window, or
custom command.

.TP
.BR \-\-title=TITLE
Sets the title for a new terminal page created with either
\-\-tab or \-\-new-window.

.TP
.BR \-\-tab\-with\-profile=PROFILE
Creates a new tab in an existing instance using the specified
profile. The profile should be a
.B UUID
string which can be found in the profile editor of the
preferences dialog.

.TP
.BR \-s ", " \-\-standalone
Run a new instance of Ptyxis, ignoring any instances already
running.

.TP
.BR \-h ", " \-\-help
Show a summary of options.

.TP
Other standard GNOME options not listed here are also supported.

.SH SEE ALSO
For further information, visit the website
https://devsuite.app/ptyxis/

.SH BUGS
Bug reports can be found and filed at
https://gitlab.gnome.org/chergert/ptyxis/issues
